-
Notifications
You must be signed in to change notification settings - Fork 13.6k
Change the desugaring of assert!
for better error output
#122661
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
rust-analyzer is developed in its own repository. If possible, consider making this change to rust-lang/rust-analyzer instead. cc @rust-lang/rust-analyzer The Miri subtree was changed cc @rust-lang/miri |
This comment has been minimized.
This comment has been minimized.
ead1593
to
eb411c1
Compare
This comment has been minimized.
This comment has been minimized.
Sigh, clippy shows at least one test where a suggestion causes there to be a condition that isn't a |
This comment was marked as resolved.
This comment was marked as resolved.
This comment has been minimized.
This comment has been minimized.
Isn't this technically a breaking change for e.g. (playground): struct Booly(i32);
impl std::ops::Not for Booly {
type Output = bool;
fn not(self) -> Self::Output {
self.0 == 0
}
}
fn main() {
assert!(Booly(1), "booly booly!")
} |
At the very least, we might need to tie such a change to an edition. I am not certain whether this decision would be a T-lang matter or a T-libs-api one. I'll nominate for T-lang for now. (Namely: The question is whether we can start enforcing a rule that the first expression to @rustbot label +I-lang-nominated |
src/tools/rust-analyzer/crates/parser/test_data/parser/ok/0035_weird_exprs.rs
Outdated
Show resolved
Hide resolved
@pnkfelix we can keep the current (undocumented) behavior by making the desugaring be {
let x: bool = !!condition;
x
} instead of what this PR does: {
let x: bool = condition;
x
} I believe that would still cause errors to complain about Edit: an option would be to have an internal marker trait: use std::ops::Not;
trait CanAssert {}
impl<T: Not<Output = bool>> CanAssert for T {}
fn main() {
let _ = Box::new(true) as Box<dyn CanAssert>;
let _ = Box::new(42) as Box<dyn CanAssert>;
}
|
@estebank what about making the expansion edition-dependent? Is there precedent for that? Then, editions >= 2024 would expand to what you have proposed in the code of this PR, and editions < 2024 could expand to the |
(to answer my own question, |
c8185ea
to
07a5b21
Compare
Some changes occurred in coverage tests. cc @Zalathar |
I tried the marker trait approach for <=2021, and it kind of worked, but the diagnostics were actually worse than just doing |
This comment has been minimized.
This comment has been minimized.
Since I don't think it's been acknowledged above, for the record, this breaks the following code:
Because |
@compiler-errors that is indeed the case for 2024 onwards, not for previous editions. |
I think the critical point is whether an edition-dependent expansion is worth breaking that case (of Update: I don't know whether it is worth going through this exercise explicitly, but there is a design space here. E.g. one set of options is:
(And then there's variations thereof about how to handle editions < 2024, but that's a separate debate IMO.) |
(this is waiting for a decision from T-lang and/or T-libs regarding what interface we want to commit to for @rustbot label: +S-waiting-on-team -S-waiting-on-review |
🎉 Experiment
|
In one crate there's a lot of:
Everything else looks like spurious cmake, docker, or download errors. |
Yes, the only "real" regression is the inference one, which only affects |
9120542
to
91371a1
Compare
This comment has been minimized.
This comment has been minimized.
@dtolnay under whose responsibility does it fall to |
since the changes are in the compiler, |
☔ The latest upstream changes (presumably #145077) made this pull request unmergeable. Please resolve the merge conflicts. |
// When the type error comes from `assert!()`, the cause and effect are reversed | ||
// because that macro expands to `match val { false => {panic!()}, _ => {} }`, which | ||
// would say something like "expected `Type`, found `bool`", confusing the user. | ||
(found, expected) = (expected, found); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this makes sense for assert, then it makes sense for all similarly structured matches.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed it to be more general: if the pattern found comes from user code, while the obligation comes from a macro, only then we revert the expectation order.
// because that macro expands to `match val { false => {panic!()}, _ => {} }`, which | ||
// would say something like | ||
// = note: expected `Type` | ||
// found `bool`" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this makes sense for assert, then it makes sense for all similarly structured matches.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a consequence of assert!(condition, msg)
expanding to
match condition {
true => {}
_ => panic!(msg),
};
On that expanded code, the output is
error[E0308]: mismatched types
--> src/main.rs:4:5
|
3 | match condition {
| --------- this expression has type `&str`
4 | true => {}
| ^^^^ expected `str`, found `bool`
but without this reversal the output for assert!("foo")
the output is:
error[E0308]: mismatched types
--> $DIR/issue-28308.rs:2:13
|
LL | assert!("foo");
| ^^^^^ expected `str`, found `bool`
which as far as the user is concerned, is always backwards.
Do note that I went over several iterations to try and make this kind of change unnecessary, like making the desugaring be let condition: bool = "foo";
, but we must rely on match ergonomics to continue supporting the prior behavior (where &bool
and bool
are accepted).
We could instead modify this to take macros in general into account to apply these changes, when the pattern is a literal coming from a macro.
I'd prefer to land the miscellaneous diagnostic, clippy and test changes separately from the desugaring change itself. |
In the desugaring of `assert!`, we now expand to a `match` expression instead of `if !cond {..}`. The span of incorrect conditions will point only at the expression, and not the whole `assert!` invocation. ``` error[E0308]: mismatched types --> $DIR/issue-14091.rs:2:13 | LL | assert!(1,1); | ^ expected `bool`, found integer ``` We no longer mention the expression needing to implement the `Not` trait. ``` error[E0308]: mismatched types --> $DIR/issue-14091-2.rs:15:13 | LL | assert!(x, x); | ^ expected `bool`, found `BytePos` ``` `assert!(val)` now desugars to: ```rust match val { true => {}, _ => $crate::panic::panic_2021!(), } ``` Fix rust-lang#122159. We make some minor changes to some diagnostics to avoid span overlap on type mismatch or inverted "expected"/"found" on type errors. We remove some unnecessary parens from core, alloc and miri.
91371a1
to
7ca135b
Compare
|
I'll split off the clippy changes shortly. Edit: rust-lang/rust-clippy#15453 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These changes need to land with this PR, as they need to be kept in sync with the macro desugaring to function properly.
Blocked on rust-lang/rust-clippy#15453 and (less so, as the reason those need to change is because the new desugaring causes the existing lint to correctly trigger) #145228. Will merge conflict with #145227. |
In the desugaring of
assert!
, we now expand to amatch
expression instead ofif !cond {..}
.The span of incorrect conditions will point only at the expression, and not the whole
assert!
invocation.We no longer mention the expression needing to implement the
Not
trait.Now
assert!(val)
desugars to:Fix #122159.